Skip to content

chore(dev): setup coderabbit for the repo#303

Merged
ioncache merged 3 commits into
mainfrom
chore/setup_coderabbit
May 23, 2026
Merged

chore(dev): setup coderabbit for the repo#303
ioncache merged 3 commits into
mainfrom
chore/setup_coderabbit

Conversation

@ioncache
Copy link
Copy Markdown
Owner

@ioncache ioncache commented May 23, 2026

Overview

Adds CodeRabbit configuration and registers the code-review AI skill so automated reviews run correctly against this repo's toolchain.

Details

  • Adds .coderabbit.yaml disabling ESLint integration (repo uses Oxlint, not ESLint)
  • Adds code-review skill definition under .agents/skills/ and .claude/skills/ so both GitHub Copilot and Claude Code agents can invoke CodeRabbit reviews
  • Adds skills-lock.json to pin the skill version
  • Adds CodeRabbit badge to README

Summary by CodeRabbit

  • Documentation

    • Added comprehensive Code Review documentation and CLI usage guide with step-by-step commands, examples, result grouping, autonomous fix workflow, and security/data-handling notes.
  • Chores

    • Disabled ESLint-based review integration.
    • Added skill version/lock metadata for reproducible skill resolution.
    • Updated project README badges to include Code Review status.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 23, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: b4e4991e-fa2a-484b-ad4b-83912580f50f

📥 Commits

Reviewing files that changed from the base of the PR and between ca7a4d8 and ef1a658.

📒 Files selected for processing (4)
  • .agents/skills/code-review/SKILL.md
  • .ai/skills/code-review.md
  • .claude/skills/code-review/SKILL.md
  • README.md

📝 Walkthrough

Walkthrough

Adds a code-review skill (agent and Claude wrappers) that forwards to a new shared CLI spec, disables the ESLint review tool, adds a skills-lock manifest, and inserts a CodeRabbit PR Reviews badge in the README.

Changes

Code-review Skill and Configuration

Layer / File(s) Summary
CodeRabbit agent SKILL wrapper
.agents/skills/code-review/SKILL.md
Front-matter metadata and a #file:../../../.ai/skills/code-review.md reference replacing in-file documentation.
Claude SKILL wrapper
.claude/skills/code-review/SKILL.md
Skill metadata, disable-model-invocation: true, and $ARGUMENTS forwarded to the shared .ai/skills/code-review.md.
Shared CLI skill documentation
.ai/skills/code-review.md
New comprehensive CLI review guide: prerequisites, flags (--agent, --dir, -t, --base, --base-commit), result grouping, autonomous fix workflow, scoped review modes, and security guidance.
Review configuration and skill versioning
.coderabbit.yaml, skills-lock.json
Disables reviews.tools.eslint in .coderabbit.yaml. Adds skills-lock.json locking the code-review skill with source metadata and computed hash.
Repository documentation
README.md
Adds a CodeRabbit PR Reviews badge to the README header badges section.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Poem

🐰 I hopped through docs and locks so neat,
I wrapped the skill in a tidy sheet,
A badge to show the review is near,
CLI guidance clear and dear,
Happy reviewing — nibble on that feat!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title directly and clearly describes the main change: setting up CodeRabbit configuration and skill definitions for the repository.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/setup_coderabbit

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 23, 2026

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 100% (🎯 100%) 154 / 154
🔵 Statements 100% (🎯 100%) 157 / 157
🔵 Functions 100% (🎯 100%) 21 / 21
🔵 Branches 100% (🎯 100%) 96 / 96
File CoverageNo changed files found.
Generated in workflow #217 for commit ef1a658 by the Vitest Coverage Report Action

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.agents/skills/code-review/SKILL.md:
- Around line 8-158: The file currently embeds the entire "CodeRabbit Code
Review" workflow instead of using the thin-wrapper pattern; locate the markdown
section starting with the "CodeRabbit Code Review" header and replace the full
duplicated body with a minimal thin-wrapper that contains only the canonical
reference (a single `#file`: pointer to the shared skill) and any required minimal
metadata, removing all duplicated capability/how-to content so the file becomes
a thin wrapper delegating to the shared skill.

In @.claude/skills/code-review/SKILL.md:
- Around line 1-158: The file is missing the Claude skill wrapper contract;
update the skill to use the wrapper format by adding the top-level flag
disable-model-invocation: true, replacing the inlined content body with the
wrapper placeholders $ARGUMENTS and the include token (e.g.
@<path-to-original-content>), and ensure the original documentation content is
moved into the included file referenced by the @... include; look for the
current skill name "code-review" and the existing full inlined content and
replace it with the wrapper header and include to restore the proper Claude
skill wrapper contract.

In `@README.md`:
- Line 5: Wrap the existing CodeRabbit badge image markdown in a link so it
becomes clickable (same pattern as the other badges); locate the badge image
string "![CodeRabbit PR
Reviews](https://img.shields.io/coderabbit/prs/github/ioncache/data-sanitization?utm_source=oss&utm_medium=github&utm_campaign=ioncache%2Fdata-sanitization&labelColor=171717&color=FF570A&link=https%3A%2F%2Fcoderabbit.ai&label=CodeRabbit+Reviews)"
in README.md and replace it with the same image wrapped by the target URL (the
CodeRabbit destination) to match how the other badges are linked. Ensure the
link uses the intended destination (https://coderabbit.ai) and retains the
existing alt text and badge URL.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: f4739c4d-a437-4ac9-afc8-cfd8e6c8bff0

📥 Commits

Reviewing files that changed from the base of the PR and between f054d5a and ca7a4d8.

📒 Files selected for processing (5)
  • .agents/skills/code-review/SKILL.md
  • .claude/skills/code-review/SKILL.md
  • .coderabbit.yaml
  • README.md
  • skills-lock.json

Comment thread .agents/skills/code-review/SKILL.md Outdated
Comment thread .claude/skills/code-review/SKILL.md Outdated
Comment thread README.md Outdated
@ioncache ioncache merged commit f894ead into main May 23, 2026
5 checks passed
@ioncache ioncache deleted the chore/setup_coderabbit branch May 23, 2026 16:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant